JAMS REST API Web Service
Setup Json Schema
Overview
Setup
acl : ACL
genericACL : Array[ACE]
identifier : string
flags : string
access : string
advanceWarning : string
alerts : Array[AlertReq]
alertID : integer
alertName : string
isInherited : boolean
autoSubmit : boolean
avgCount : integer
avgElapsedTime : string
avgJobCount : integer
batchQueueID : integer
batchQueueName : string
defaultDate : string
defaultSubmitTime : string
dependencies : Array[Dependency]
dependencyName : string
dependencyType : string
dependID : integer
description : string
lastChangeUTC : string
description : string
exceptForDate : string
jobs : Array[SetupJob]
agentNode : string
alerts : Array[Alert]
alertID : integer
alertName : string
description : string
detailText : string
eventList : Array[]
handlerList : string
inheritanceName : string
lastChangedBy : string
lastChangeUTC : string
notifyNames : string
summaryText : string
avgBufferedIOCount : integer
avgCount : integer
avgCpuTime : string
avgDirectIOCount : integer
avgElapsedTime : string
avgPageFaults : integer
avgWorkingSetPeak : integer
batchQueueID : integer
batchQueueName : string
description : string
detailID : integer
exceptForDate : string
failureAction : string
isRelative : boolean
jobDescription : string
jobID : integer
jobName : string
lastChangeUTC : string
logFilename : string
maxBufferedIOCount : integer
maxCount : integer
maxCpuTime : string
maxDirectIOCount : integer
maxElapsedTime : string
maxPageFaults : integer
maxWorkingSetPeak : integer
minBufferedIOCount : integer
minCount : integer
minCpuTime : string
minDirectIOCount : integer
minElapsedTime : string
minimumSeverity : string
minPageFaults : integer
minWorkingSetPeak : integer
missedWindowAction : string
nonWorkdayScheduling : string
notifyEMail : string
notifyJobID : integer
notifyJobName : string
notifyJobNameIsRelative : boolean
notifyOfMissedWindow : string
notifyOther : string
notifySeverity : string
notifyUsers : string
overrideDescription : string
overrideName : string
parameters : Array[SetupJobParam]
allowEntry : string
defaultValue : string
globalName : string
hide : string
lastChangeUTC : string
mustFill : string
overridden : boolean
overriden : boolean
paramName : string
prompt : string
required : string
sequence : integer
submitPrompt : string
variableID : integer
variableName : string
variableNameIsRelative : boolean
precheckInterval : string
precheckJobID : integer
precheckJobName : string
precheckJobNameIsRelative : boolean
recoverJobID : integer
recoverJobName : string
recoverJobNameIsRelative : boolean
recoverySeverity : string
reports : Array[SetupJobReport]
copies : integer
fullFilename : string
lastChangeUTC : string
overriden : boolean
printForm : string
printQualifiers : string
printQueue : string
reportID : string
retentionDays : integer
retryCount : integer
retryInterval : string
runawayAction : string
runawayElapsed : string
runawayElapsedPer : integer
runPriority : integer
scheduledDate : string
scheduleFromTime : string
scheduleToTime : string
scheduleWindowID : integer
scheduleWindowName : string
schedulingPriorityModifier : integer
setupID : integer
shortElapsed : string
shortElapsedPer : integer
shortSeverity : string
stalledTime : string
step : integer
submitOnHold : string
userID : integer
userName : string
waitFor : boolean
lastAutosubmitUTC : string
lastBadUTC : string
lastChangedBy : string
lastChangeUTC : string
lastGoodUTC : string
lastResetUTC : string
logFilename : string
keepLogs : string
timestampLogs : string
maxCount : integer
maxElapsedTime : string
maxJobCount : integer
minCount : integer
minElapsedTime : string
minJobCount : integer
missedWindowAction : string
notifyEMail : string
notifyJobID : integer
notifyJobName : string
notifyJobNameIsRelative : boolean
notifyOfMissedWindow : boolean
notifyOther : string
notifySeverity : string
notifyUser : boolean
notifyUsers : string
parentFolderId : integer
parentFolderName : string
precheckJobName : string
prechkInterval : string
precheckJobNameIsRelative : boolean
prechkJobID : integer
qualifiedName : string
recoverJobNameIsRelative : boolean
recoverJobID : integer
recoverJobName : string
recoverSeverity : string
recoveryInstructions : string
references : Array[SetupRef]
referenceID : integer
name : string
type : string
description : string
folderPath : string
requirements : Array[ResReq]
autoRelease : boolean
lastChangeUTC : string
netQuantityRequired : integer
quantityInherited : integer
quantityRequired : integer
resourceID : integer
resourceName : string
retainOnFailure : boolean
restartable : boolean
resubmitBase : string
resubmitDelay : string
resubmitEnd : string
resubmitOnError : boolean
retainOption : string
retainTime : string
retryCount : integer
retryInterval : string
runawayAction : string
runawayElapsed : string
runawayElapsedPer : integer
scheduledDate : string
scheduledDateEnd : string
scheduledDateStart : string
scheduledTime : string
schedulingPriorityModifier : integer
scheduleWindowName : string
setupID : integer
setupName : string
shortElapsed : string
shortElapsedPer : integer
failShort : boolean
slaTime : string
stalledTime : string
submitOnHold : boolean
submitTime : string
suppressMenuDisplay : boolean
timeZoneID : integer
timeZoneName : string
defaultUserName : string
scheduleFromTime : string
scheduleToTime : string
scheduleWindowID : integer
nonWorkdayScheduling : string
Properties
NameDescriptionData Type
acl ACL
advanceWarning string
alerts Array[AlertReq]
autoSubmit boolean
avgCount integer
avgElapsedTime string
avgJobCount integer
batchQueueID integer
batchQueueName string
defaultDate string
defaultSubmitTime string
dependencies Array[Dependency]
description string
exceptForDate string
jobs Array[SetupJob]
lastAutosubmitUTC string
lastBadUTC string
lastChangedBy string
lastChangeUTC string
lastGoodUTC string
lastResetUTC string
logFilename string
keepLogs string
timestampLogs string
maxCount integer
maxElapsedTime string
maxJobCount integer
minCount integer
minElapsedTime string
minJobCount integer
missedWindowAction string
notifyEMail string
notifyJobID integer
notifyJobName string
notifyJobNameIsRelative boolean
notifyOfMissedWindow boolean
notifyOther string
notifySeverity string
notifyUser boolean
notifyUsers string
parentFolderId integer
parentFolderName string
precheckJobName string
prechkInterval string
precheckJobNameIsRelative boolean
prechkJobID integer
qualifiedName string
recoverJobNameIsRelative boolean
recoverJobID integer
recoverJobName string
recoverSeverity string
recoveryInstructions string
references Array[SetupRef]
requirements Array[ResReq]
restartable boolean
resubmitBase string
resubmitDelay string
resubmitEnd string
resubmitOnError boolean
retainOption string
retainTime string
retryCount integer
retryInterval string
runawayAction string
runawayElapsed string
runawayElapsedPer integer
scheduledDate string
scheduledDateEnd string
scheduledDateStart string
scheduledTime string
schedulingPriorityModifier integer
scheduleWindowName string
setupID integer
setupName string
shortElapsed string
shortElapsedPer integer
failShort boolean
slaTime string
stalledTime string
submitOnHold boolean
submitTime string
suppressMenuDisplay boolean
timeZoneID integer
timeZoneName string
defaultUserName string
scheduleFromTime string
scheduleToTime string
scheduleWindowID integer
nonWorkdayScheduling string
See Also
JAMS REST API Web Service

 

 


© 2017 All Rights Reserved.

Send comments on this topic.